Arc-It-Up Document Archiving System is brought to you by BroadGun Software. Arc-It-Up may be used without fee. Conditions regarding license and legal information can be found in the license.txt file obtained with the installation of Arc-It-Up Server. ========================== Arc-It-Up Readme ========================== This file contains the following sections: 1. System Requirements 2. Installing the Arc-It-Up Server 3. Installing the Arc-It-Up Client 4. Arc-It-Up Server Operations 5. Submitting a record to Arc-It-Up 6. Searching for a record in Arc-It-Up 7. Viewing a record in Arc-It-Up 8. Uninstalling Arc-It-Up 9. Reinstalling Arc-It-Up Server 10. License information 11. Backing up your data 12. Troubleshooting 13. Contact details for BroadGun Software ___________________________________________________________________ 1. SYSTEM REQUIREMENTS ------------------------------------------------------------------- Arc-It-Up is a client-server application. That is, there is a client software component and a server software component. NOTE: If you only have a single PC, then that PC can be the client and the server at the same time. a) Arc-It-Up Server ---------------- The server software component is required to run on a single IBM compatible PC which can be accessed on the network by each of the PC(s) from which you want to be able to submit documents into storage. The PC for the Arc-It-Up Server must be running Windows 95, Windows 98 or Windows NT 4.0. To install the server software component you will need to get the file "Arc-It-Up_ServerV1.0.exe". This file may have been downloaded with this readme file. If not, you can get this file from the BroadGun Software, Arc-It-Up home page: http:\\www.broadgun.com\Arc-It-Up_ServerV1.0.exe b) Arc-It-Up Client ---------------- The client software component is required to run on each PC from which you want to be able to submit documents into storage (the client PC(s)). These PC(s) must be IBM compatible and may be running Windows 95, Windows 98 or Windows NT 4.0. The PC(s) must also have a Windows compatible Web Browser installed (for example, Microsoft Internet Explorer or Netscape Navigator). These PC(s) must be able to see the server PC on the network. To install the client software component you will need to get the file "Arc-It-Up_Client_V1.0.exe". This file may have been downloaded with this readme file. If not, you can get this file from the BroadGun Software, Arc-It-Up home page: http:\\www.broadgun.com\Arc-It-Up_Client_V1.0.exe NOTE: The server and the client do not have to be running the same operating system. For example you may have an NT 4.0 server and a mixture of Windows 98 and NT 5.0 clients. ___________________________________________________________________ 2. INSTALLING THE Arc-It-Up SERVER ------------------------------------------------------------------- Once you have followed the directions in section 1 you should have all of the necessary components to install Arc-It-Up. You should also have identified the PC upon which you will install the server software component. Running the downloaded executable will install the Arc-It-Up Server. Prompts along the way will provide you with the necessary information, however detailed instructions are documented below to ensure that no difficulties are encountered. To install the Arc-It-Up Server: 1) Run the executable named Arc-It-Up_ServerV1.0.exe. a) You will be prompted for a temporary directory to which the downloaded program will unzip the files required for installation of Arc-It-Up Server. Enter the appropriate temporary directory and press the Unzip button. b) The downloaded program will then unzip the files and inform you of completion. Press OK 2) The installation program (setup.exe) will now run. a) You will be requested to confirm whether you want to install the Arc-It-Up Server. Press Yes if you are ready to install the Arc-It-Up Server. b) At this stage, the installation program will check for any existing installations of Arc-It-Up. If any existing installation is found you will be informed and requested to confirm re-installation. If you are re-installing the Arc-It-Up Server you should refer to the section in this file on re-installing Arc-It-Up. c) You are now required to enter information that is vital for the operation of Arc-It-Up: "Install to directory" - this is the directory in which the program files for Arc-It-Up will be installed. If you enter a directory name which does not exist, you will be prompted to confirm creation of this directory. "Data Directory" - this is the directory in which your archived records and associated information will be stored. You should therefore ensure you choose a destination which will have sufficient disk space for you to archive records. If you enter a directory name which does not exist, you will be prompted to confirm creation of this directory. "TCP/IP Port" - this is the port through which the Arc-It-Up http Server will communicate with the Arc-It-Up client. If you are already running a web server on this PC then you may wish to change this. If you are not then you can probably leave it at its default setting. If there is a problem with this setting you will be informed on startup of Arc-It-Up. If this occurs refer to the Section on Trouble Shooting in this file. Once you have entered this information, press the OK button. d) The installation program will now install Arc-It-Up for you. On completion of the installation you will be informed of success or failure. Press OK on this message box to finish the installation. Note that in the case of failure there will be message boxes informing you of the reason for failure. You may be required to reboot your computer before running Arc-It-Up. If this is required the installation program will inform you and provide you the option to reboot immediately. If you do not wish to reboot immediately then make sure you reboot before attempting to use Arc-It-Up. The Arc-It-Up Server is now installed and available in your Start Menu under Program Files, BroadGun Software, Arc-It-Up. It is also setup to automatically start when you login to your Windows desktop. ___________________________________________________________________ 3. INSTALLING THE Arc-It-Up CLIENT ------------------------------------------------------------------- Once you have followed the directions in section 1 you should have all of the necessary components to install Arc-It-Up. You should also have identified the PC(s) from which you wish to submit records into Arc-It-Up. Of course, you can always install Arc-It-Up client onto other PCs at a later time. Running the downloaded executable will install the Arc-It-Up Client. Prompts along the way will provide you with the necessary information, however detailed instructions are documented below to ensure that no difficulties are encountered. To install the Arc-It-Up Client, follow these instructions on each client PC: 1) Run the executable named Arc-It-Up_Client_V1.0.exe. a) You will be prompted for a temporary directory to which the downloaded program will unzip the files required for installation of Arc-It-Up Client. Enter the appropriate temporary directory and press the Unzip button. b) The downloaded program will then unzip the files and inform you of completion. Press OK 2) The installation program (setup.exe) will now run. a) You will be requested to confirm whether you want to install the Arc-It-Up Client. Press Yes if you are ready to install the Arc-It-Up Client. b) Arc-It-Up will now install its Print Monitor (Mango Print Monitor), its Print Driver (Arc-It-Up Print Driver) and the Arc-It-Up Printer. If any of these already exist you will be notified by a message box, however the installation will continue. c) You are now required to enter information that is vital for the Arc-It-Up client to find the Arc-It-Up server: "TCP/IP Address of server" - this is the address of the PC where the Arc-It-Up Server is installed. This address may be a domain name or a tcp/ip address. "TCP/IP Port" - this is the port through which the Arc-It-Up client will communicate with the Arc-It-Up http Server. You should make this the same as that which you configured the server. Once you have entered this information, press the OK button. (NOTE: this information may be modified on the client when you are submitting a record). d) The installation program will now install the Arc-It-Up client for you. On completion of the installation you will be informed of success or failure. Press OK on this message box to finish the installation. Note that in the case of failure there will be message boxes informing you of the reason for failure. You may be required to reboot your computer before running Arc-It-Up. If this is required the installation program will inform you and provide you the option to reboot immediately. If you do not wish to reboot immediately then make sure you reboot before attempting to use Arc-It-Up. ___________________________________________________________________ 4. Arc-It-Up SERVER OPERATIONS ------------------------------------------------------------------- After installation the Arc-It-Up Server is available in your Start Menu under Program Files, BroadGun Software, Arc-It-Up. It is also setup to automatically start when you login to your Windows desktop. When the Arc-It-Up Server is running the Arc-It-Up icon is visible in the system tray. All Arc-It-Up Server operations are initiated by clicking the right mouse button on the Arc-It-Up Server icon in the system tray. This displays a small pop-up menu with the available operations listed. Operations are selected from the pop-up menu by clicking with the left mouse button. There are three operations available: a) About - Information about Arc-It-Up. b) View Log - Displays the Arc-It-Up Server log file. d) Exit - Shuts down the Arc-It-Up Server. ___________________________________________________________________ 5. SUBMITTING A RECORD TO Arc-It-Up ------------------------------------------------------------------- Storing a record in Arc-It-Up is as simple as printing the record: a) open the record in the application in which it was created or received. For example, open the record in MS Word, your email client, your CAD program. b) From the open application select to Print the record to the Arc-It-Up Printer. c) Arc-It-Up will prompt you with a dialog box which displays a default title. You may over-write this title with a specific title of your choice. You may also add keywords which will help you or your colleagues find this record at a later date. Press OK to store the record in Arc-It-Up. Arc-It-Up will respond with a successful or unsuccessful message. On successful storage of your record, Arc-It-Up will display a unique identifier (Document ID) assigned to your record. If you wish you can use the "Goto Search" button to find your record in Arc-It-Up. Press Cancel to cancel the operation. NOTE: Arc-It-Up will index the record with all textual words contained in the record, the title and the keywords entered upon submission. This saves you from entering them as keywords. NOTE: Bitmaps and images in the shape of text are not textual words and will not be automatically indexed. If these are important to find the record later, then add them as keywords. If your application lets you convert these images to text (eg scan software with OCR capability) then use this to convert the image to text, then copy and paste the text into the keywords edit box on Arc-It-Up. The dialog displayed during submission of a record to Arc-It-Up also provides you with the following operations: a) Server - allows you to modify the tcp/ip address and port that was entered upon installation of the client. b) About - provides you information about Arc-It-Up. ___________________________________________________________________ 6. SEARCHING FOR A RECORD IN Arc-It-Up ------------------------------------------------------------------- To find a record in Arc-It-Up you first need to open your Windows compatible Web Browser (eg Microsoft Internet Explorer, Netscape Navigator). Navigate to the Arc-It-Up search page by entering the following url - replacing "YourServerAddress" with your Arc-It-Up server address and "YourServerPort" with your Arc-It-Up server port number. http://YourServerAddress:YourServerPort/searcher?start If you have this correct, the Arc-It-Up Search Form will display. NOTE: If you have forgotten your server address and port number you can find them by starting to submit a new record and selecting the "Server" button on the dialog. This will display the last used Server address and Port. Cancel from the submit if you do not wish to continue. There are two methods of finding a record in Arc-It-Up from the Arc-It-Up Search Form: a) Search by Document ID - enter the unique identifier of the record you wish to find and select the Search button. If a record matching that identifier exists it will be listed on the response page. a) Search by Keyword - enter words that are key in identifying the record you wish to find and select the Search button. Records that have keywords matching any of those words will be listed, with records with the highest number of matches listed first. Using either of these methods you will have a response which informs you of the number of matches to your search, and if there were any matches - a list of record titles matching your search. The date the records were stored in Arc-It-Up is also listed. You can customize the number of titles listed on a page by modifying the "Number of results per page" before performing a search. If the number of records which are match your search is greater than the number of records displayed in a page the Search Form will also display a navigation area which allows you to move between pages. Navigate between pages by clicking on the page number you wish to display. NOTE: Increasing the accuracy of the keywords you enter in the search will increase the likelihood of the desired record appearing in the first page(s) of the search results. ___________________________________________________________________ 7. VIEWING A RECORD IN Arc-It-Up ------------------------------------------------------------------- Once you have searched for and displayed a list of records you can then choose to view that record. Each record title listed is a hyperlink that when clicked upon will retrieve the record from the server and display it for you. The drop down box "Download documents in format" provides a number of choices regarding the format in which you wish to view the record. You choose the format by clicking on the drop down box and selecting the required format. NOTE: Choose a format for which you have a viewer installed on your PC. There are many document viewers available in the marketplace. Choose the one that suits you and your environment. For example, ADOBE Acrobat (PDF) can be viewed by ADOBE Acrobat Reader, TIFF Images can be viewed by Wang Imaging for Windows NT. ___________________________________________________________________ 8. UN-INSTALLING Arc-It-Up ------------------------------------------------------------------- a) Arc-It-Up Server ---------------- Uninstall Arc-It-Up Server through the Windows Control Panel, Add/Remove Programs interface. Uninstalling Arc-It-Up will not delete any data created using Arc-It-Up, nor any directory structure created upon installation of Arc-It-Up. However, new installations of Arc-It-Up will not detect nor use this data. b) Arc-It-Up Client ---------------- Use the Windows Printer Interface to delete the Arc-It-Up printer. ___________________________________________________________________ 9. RE-INSTALLING Arc-It-Up Server ------------------------------------------------------------------- If you wish to re-install the Arc-It-Up Server for any reason while you still have it installed (for example, a new version of the Arc-It-Up server is released) then you need to be careful not to overwrite any data that you already have stored in Arc-It-Up. The Arc-It-Up installation will detect an existing installation of Arc-It-Up and prompt you with details of this installation. If you wish to maintain the use of the existing data you have stored in Arc-It-Up then you must not change the location of the data directory. ___________________________________________________________________ 10. LICENSE INFORMATION ------------------------------------------------------------------- Arc-It-Up may be used without fee. Conditions regarding license and legal information can be found in the license.txt file obtained with the download of Arc-It-Up. You should read this file to ensure you understand the conditions of use. GNU Ghostscript version 5.10 and GDBM ( the GNU data base manager) version 1.7.3 are aggregated with Arc-It-Up. GNU Ghostscript and GDBM are subject to the GNU GENERAL PUBLIC LICENSE Copyright (C) 1989, 1991 Free Software Foundation, Inc. This can be found in the file COPYING which is found in the gs directory upon installation of Arc-It-Up. ___________________________________________________________________ 11. BACKING UP YOUR DATA ------------------------------------------------------------------- Arc-It-Up stores all data regarding your archived files in the data directory which is specified on installation. You should ensure that you incorporate backup of the full contents of this directory as well as the Windows registry into your backup plan. ___________________________________________________________________ 12. TROUBLE SHOOTING ------------------------------------------------------------------- ___________________________________________________________________ 13. CONTACT DETAILS FOR BroadGun Software ------------------------------------------------------------------- BroadGun Software can be contacted at: Web: http://www.broadgun.com Email: craig@broadgun.com Post: 20 Lawry St Northcote 3070 Australia BroadGun Software welcomes your comments and suggestions. Although no warranty is supplied and no guarantee of any modifications to software is provided BroadGun Software would appreciate any feedback that you care to provide.